Persons API

The webservice is exposed in REST and is secured and client_id/client_secret enabled.

PERSONS

This operation gets the person details by his id

REQUEST

url: /rest/v1/persons
URI parameters:
personId=Person ID in Connect

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiVersion": {schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "personId": Person ID in connect,
        "idVinci": "VINCI ID of the person",
        "personLastName": "Last Name",
        "personFirstName": "First Name",
        "customaryLastName": "Customary Last Name",
        "customaryFirstName": "Customary First Name",
        "gender": gender,
        "birthDate": "Birth Date",
        "personEmail": "person email",
        "employeeNumber": payroll employee number,
        "businessUnitRocId": Business Unit ROC ID of the person,
        "businessUnitName": "Business Unit Name of the person",
        "businessUnitActiveFlag": "Business Unit active or not",
        "recordOrigin": --------tbd-----------,
        "upn": "Person UPN",
        "osmose": Osmose code,
        "photo": "Photo link of the person",
        "leaveDate": "Person leave date",
        "startDate": "Person start date",
        "active": "Person active or not",
        "noEmailFlag": "Person have email or not",
        "noTelephoneFlag": "Person have telephone or not",
        "noMobileFlag": "Person have mobile or not",
        "maskedFlag": "Person is masked or not",
        "telephoneFilledFlag": "Person telephone is filled or not",
        "mobileFilledFlag": "Person mobile is filled or not",
        "employeeType": Employee type,
        "numberDetachments": Number of detachments,
        "managerId": CONNECT ID of the manager,
        "automatedRecordFlag": "--------------tbd--------------",
        "mainBusinessUnitRocId": ROC ID of the main business unit of the employee,
        "noPhotoFlag": "Person have a photo or not",
        "jobTitle": "Person job title",
        "jobFamily": "Person job family",
        "jobActivity": "Person actvity",
        "updateDate": "Last Update Date",
        "mainManagerId": Connect ID of the main manager,
        "telephone": "Person phone number",
        "fax": "Person fax",
        "mobile": "Person mobile phone",
        "businessUnitCode": ROC ID of the Business Unit,
        "language": "fr",
        "appraisalManagerId": CONNECT ID of the Appraisal Manager,
        "poleRocId": ROC ID of the pole,
        "sourceSystem": "Source system",
        "employeeSource": "Source of the person",
        "contactLanguageCode": "Language of the person",
        "contactLanguageId": ROC ID of the person language,
        "personType": Connect person type,
        "wageManagerId": CONNECT ID of the wage manager,
        "photoUpdateDate": "Last date of photo upadte",
        "jobFamilyId": CONNECT ID of the Job Family,
        "jobActivityId": CONNECT ID of the Activity Famil
    },
    "error": {}
}

Possible values for personType

• 1: Internal Auto
• 11: External
• 10: Internal

PERSONS LIGHT

This operation gets the person UPN by his id

REQUEST

url: /rest/v1/persons/upn
URI parameters:
personId=Person ID in Connect

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiVersion": {schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "upn": "Person UPN",
    },
    "error": {}
}

TEAMS-STATUS

This operation gets the person teams status from Microsoft services

Possible values for Availability:

• Available
• AvailableIdle
• Away
• BeRightBack
• Busy
• BusyIdle
• DoNotDisturb
• Offline
• PresenceUnknown

Possible values for Activity:

• Available
• Away
• BeRightBack
• Busy
• DoNotDisturb
• InACall
• InAConferenceCall
• Inactive
• InAMeeting
• Offline
• OffWork
• OutOfOffice
• PresenceUnknown
• Presenting
• UrgentInterruptionsOnly

REQUEST

url: /rest/v1/teams-status
URI parameters:
upn=Person UPN from Check

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiVersion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "upn": "firstname.lastname@vinci-energies.net",
        "availability": "Away",
        "activity": "Away"
    },
    "error": {}
}